////////////////////////////////////////////////////////////////////////////////
//
// Filename: 	mlist.h
//
// Project:	AutoFPGA, a utility for composing FPGA designs from peripherals
//
// Purpose:	An MLIST is a list of bus masters.  This file defines the
//		methods associated with such a list.
//
//
// Creator:	Dan Gisselquist, Ph.D.
//		Gisselquist Technology, LLC
//
////////////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2017-2020, Gisselquist Technology, LLC
//
// This program is free software (firmware): you can redistribute it and/or
// modify it under the terms of  the GNU General Public License as published
// by the Free Software Foundation, either version 3 of the License, or (at
// your option) any later version.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or
// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
// for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program.  (It's in the $(ROOT)/doc directory.  Run make with no
// target there if the PDF file isn't present.)  If not, see
// <http://www.gnu.org/licenses/> for a copy.
//
// License:	GPL, v3, as defined and found on www.gnu.org,
//		http://www.gnu.org/licenses/gpl.html
//
//
////////////////////////////////////////////////////////////////////////////////
//
//
#ifndef	MLIST_H
#define	MLIST_H

#include <vector>

#include "parser.h"

class	BUSINFO;

//
// The MLIST, made of B(us)MASTER(s)
//
// A structure to contain information about lists of bus masters
//
class	BMASTER {
public:
	MAPDHASH	*m_hash;
	STRINGP		name(void);
	STRINGP		bus_prefix(void);
	bool		read_only(void);
	bool		write_only(void);

	BMASTER(MAPDHASH *hash) : m_hash(hash) {};
};

typedef	BMASTER *BMASTERP;

typedef	std::vector<BMASTERP> MLIST;

// A pointer to a set of peripherals
typedef	MLIST *MLISTP;

#endif	// MLIST_H
